Interface: CallOptions
Properties
ack
• ack: (opt
: { breakoutUuid?
: string
; callUuid?
: string
; conferenceAlias?
: string
; host?
: string
; offerIgnored?
: boolean
; participantUuid?
: string
; sdp?
: string
}) => Promise
<undefined
| AckResponse
> & { breakoutUuid?
: string
}
callSignals
• callSignals: CallSignals
callType
• Optional
callType: ClientCallType
dataChannelId
• Optional
dataChannelId: number
eventSignals
• eventSignals: EventSignals
getCurrentCallUuid
• getCurrentCallUuid: () => CallUuid
Type declaration
▸ (): CallUuid
Returns
isDirectMedia
• isDirectMedia: boolean
mainStatsSignals
• mainStatsSignals: MainStatsSignals
mediaPriorities
• Optional
mediaPriorities: MediaPriority
mediaStream
• Optional
mediaStream: MediaStream
newCandidate
• newCandidate: (opt
: { breakoutUuid?
: string
; candidate
: IceCandidate
}) => Promise
<undefined
| NewCandidateResponse
>
Type declaration
▸ (opt
): Promise
<undefined
| NewCandidateResponse
>
Parameters
Name | Type |
---|---|
opt | Object |
opt.breakoutUuid? | string |
opt.candidate | IceCandidate |
Returns
Promise
<undefined
| NewCandidateResponse
>
pcMainSignals
• pcMainSignals: Pick
<CorePeerConnectionSignals
& Omit
<PeerConnectionCommandSignals
, "onReceiveIceCandidate"
> & Required
<PCOptionalsSignals
>, "onReceiveIceCandidate"
| "onOfferRequired"
| "onReceiveAnswer"
| "onReceiveOffer"
| "onConnectionStateChange"
| "onIceCandidate"
| "onIceConnectionStateChange"
| "onRemoteStreams"
| "onTransceiverChange"
| "onSecureCheckCode"
| "onError"
| "onOfferIgnored"
| "onOffer"
| "onAnswer"
>
peerOptions
• peerOptions: PeerConnectionOptions
releaseFloor
• releaseFloor: (opts
: { breakoutUuid?
: string
; conferenceAlias?
: string
; host?
: string
; participantUuid?
: string
}) => Promise
<undefined
| ReleaseFloorResponse
>
Type declaration
▸ (opts
): Promise
<undefined
| ReleaseFloorResponse
>
Parameters
Name | Type |
---|---|
opts | Object |
opts.breakoutUuid? | string |
opts.conferenceAlias? | string |
opts.host? | string |
opts.participantUuid? | string |
Returns
Promise
<undefined
| ReleaseFloorResponse
>
sendOffer
• sendOffer: (opt
: { breakoutUuid?
: string
; sdp
: string
}) => Promise
<undefined
| CallsWebrtcParticipantResponse
>
Type declaration
▸ (opt
): Promise
<undefined
| CallsWebrtcParticipantResponse
>
Parameters
Name | Type |
---|---|
opt | Object |
opt.breakoutUuid? | string |
opt.sdp | string |
Returns
Promise
<undefined
| CallsWebrtcParticipantResponse
>
signals
• signals: InfinitySignals
takeFloor
• takeFloor: (opts
: { breakoutUuid?
: string
; conferenceAlias?
: string
; host?
: string
; participantUuid?
: string
}) => Promise
<undefined
| TakeFloorResponse
>
Type declaration
▸ (opts
): Promise
<undefined
| TakeFloorResponse
>
Parameters
Name | Type |
---|---|
opts | Object |
opts.breakoutUuid? | string |
opts.conferenceAlias? | string |
opts.host? | string |
opts.participantUuid? | string |
Returns
Promise
<undefined
| TakeFloorResponse
>
update
• update: (opt
: { abortSignal?
: AbortSignal
; breakoutUuid?
: string
; sdp
: string
}) => Promise
<undefined
| UpdateResponse
>
Type declaration
▸ (opt
): Promise
<undefined
| UpdateResponse
>
Parameters
Name | Type |
---|---|
opt | Object |
opt.abortSignal? | AbortSignal |
opt.breakoutUuid? | string |
opt.sdp | string |
Returns
Promise
<undefined
| UpdateResponse
>